/*
 * Licensed to Elasticsearch B.V. under one or more contributor
 * license agreements. See the NOTICE file distributed with
 * this work for additional information regarding copyright
 * ownership. Elasticsearch B.V. licenses this file to you under
 * the Apache License, Version 2.0 (the "License"); you may
 * not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 *    http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing,
 * software distributed under the License is distributed on an
 * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
 * KIND, either express or implied.  See the License for the
 * specific language governing permissions and limitations
 * under the License.
 */

using System.Runtime.Serialization;
using Elasticsearch.Net;

namespace Nest
{
	/// <summary>
	/// The status of categorization for the job.
	/// </summary>
	[StringEnum]
	public enum ModelCategorizationStatus
	{
		/// <summary>
		/// Categorization is performing acceptably well (or not being used at all).
		/// </summary>
		[EnumMember(Value = "ok")]
		// ReSharper disable once InconsistentNaming
		OK,

		/// <summary>
		/// Categorization is detecting a distribution of categories that suggests the input data is inappropriate for categorization.
		/// Problems could be that there is only one category, more than 90% of categories are rare, the number of categories is greater
		/// than 50% of the number of categorized documents, there are no frequently matched categories, or more than 50% of categories
		/// are dead.
		/// </summary>
		[EnumMember(Value = "warn")]
		Warn
	}
}
